

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The exceptions module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The pyamp module" href="mod_pyamp.html" />
    <link rel="next" title="Changelog" href="../changelog.html" />
    <link rel="prev" title="The coroutine module" href="pyamp_processes_coroutine.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../changelog.html" title="Changelog"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pyamp_processes_coroutine.html" title="The coroutine module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" accesskey="U">The pyamp module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.exceptions">
<span id="the-exceptions-module"></span><h1>The exceptions module<a class="headerlink" href="#module-pyamp.exceptions" title="Permalink to this headline">¶</a></h1>
<p>The exceptions module contains definitions of common Exception
classes which are used throughout the pyamp project to indicate
errors to the programmer.</p>
<div class="section" id="the-finalfunctionerror-class">
<h2>The FinalFunctionError class<a class="headerlink" href="#the-finalfunctionerror-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-0d8d3d4206aab956cacf83397fadf7a4f46298a6.png" alt="Inheritance diagram of pyamp.exceptions.FinalFunctionError" usemap="#inheritanceb9fad89006" class="inheritance"/>
<map id="inheritanceb9fad89006" name="inheritanceb9fad89006">
<area shape="rect" href="#pyamp.exceptions.FinalFunctionError" title="pyamp.exceptions.FinalFunctionError" alt="" coords="5,7,259,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.exceptions.FinalFunctionError">
<em class="property">class </em><tt class="descclassname">pyamp.exceptions.</tt><tt class="descname">FinalFunctionError</tt><big>(</big><em>classObj</em>, <em>functionName</em><big>)</big><a class="reference internal" href="../_modules/pyamp/exceptions.html#FinalFunctionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.exceptions.FinalFunctionError" title="Permalink to this definition">¶</a></dt>
<dd><p>The FinalFunctionError class provides an Exception which is raised
in the event that a class attempts to override a final function.</p>
<ul class="simple">
<li>classObj &#8211; The classObj (class, instance, or a string)</li>
<li>functionName &#8211; The name of final function</li>
</ul>
</dd></dl>

</div>
<div class="section" id="the-invalidpropertyvalueerror-class">
<h2>The InvalidPropertyValueError class<a class="headerlink" href="#the-invalidpropertyvalueerror-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-63aedc1bdc9d38f984241953c453406241cd6a91.png" alt="Inheritance diagram of pyamp.exceptions.InvalidPropertyValueError" usemap="#inheritanceb7cb44a5ff" class="inheritance"/>
<map id="inheritanceb7cb44a5ff" name="inheritanceb7cb44a5ff">
<area shape="rect" href="#pyamp.exceptions.InvalidPropertyValueError" title="pyamp.exceptions.InvalidPropertyValueError" alt="" coords="5,7,307,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.exceptions.InvalidPropertyValueError">
<em class="property">class </em><tt class="descclassname">pyamp.exceptions.</tt><tt class="descname">InvalidPropertyValueError</tt><big>(</big><em>classObj</em>, <em>propName</em>, <em>value</em>, <em>expected</em><big>)</big><a class="reference internal" href="../_modules/pyamp/exceptions.html#InvalidPropertyValueError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.exceptions.InvalidPropertyValueError" title="Permalink to this definition">¶</a></dt>
<dd><p>The InvalidPropertyValueError is raised in the event that a class
property has an unexpected, or invalid, value.</p>
<ul class="simple">
<li>classObj &#8211; The class obj (class, instance, or string name)</li>
<li>propName &#8211; The name of the invalid property</li>
<li>value &#8211; The invalid property value</li>
<li>expected &#8211; The expected value for the property</li>
</ul>
</dd></dl>

</div>
<div class="section" id="the-undefinedfunctionerror-class">
<h2>The UndefinedFunctionError class<a class="headerlink" href="#the-undefinedfunctionerror-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-d880baf1625b33a3b1914bda92934537e4e3858f.png" alt="Inheritance diagram of pyamp.exceptions.UndefinedFunctionError" usemap="#inheritance9673b6c0e9" class="inheritance"/>
<map id="inheritance9673b6c0e9" name="inheritance9673b6c0e9">
<area shape="rect" href="#pyamp.exceptions.UndefinedFunctionError" title="pyamp.exceptions.UndefinedFunctionError" alt="" coords="5,7,296,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.exceptions.UndefinedFunctionError">
<em class="property">class </em><tt class="descclassname">pyamp.exceptions.</tt><tt class="descname">UndefinedFunctionError</tt><big>(</big><em>obj</em>, <em>functionName</em><big>)</big><a class="reference internal" href="../_modules/pyamp/exceptions.html#UndefinedFunctionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.exceptions.UndefinedFunctionError" title="Permalink to this definition">¶</a></dt>
<dd><p>A class or object is missing a required function.</p>
<ul class="simple">
<li>obj &#8211; The class or object</li>
<li>functionName &#8211; The name of the required function</li>
</ul>
</dd></dl>

</div>
<div class="section" id="the-undefinedpropertyerror-class">
<h2>The UndefinedPropertyError class<a class="headerlink" href="#the-undefinedpropertyerror-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-33029bd62b069a60aeae988c38ff41072b07de6b.png" alt="Inheritance diagram of pyamp.exceptions.UndefinedPropertyError" usemap="#inheritance470656eaa6" class="inheritance"/>
<map id="inheritance470656eaa6" name="inheritance470656eaa6">
<area shape="rect" href="#pyamp.exceptions.UndefinedPropertyError" title="pyamp.exceptions.UndefinedPropertyError" alt="" coords="5,7,296,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.exceptions.UndefinedPropertyError">
<em class="property">class </em><tt class="descclassname">pyamp.exceptions.</tt><tt class="descname">UndefinedPropertyError</tt><big>(</big><em>obj</em>, <em>propertyName</em><big>)</big><a class="reference internal" href="../_modules/pyamp/exceptions.html#UndefinedPropertyError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.exceptions.UndefinedPropertyError" title="Permalink to this definition">¶</a></dt>
<dd><p>A class or object is missing a required property.</p>
<ul class="simple">
<li>obj &#8211; The class or object</li>
<li>propertyName &#8211; The name of the property that is required</li>
</ul>
</dd></dl>

</div>
<div class="section" id="the-invalidconfigurationpropertyvalueerror-class">
<h2>The InvalidConfigurationPropertyValueError class<a class="headerlink" href="#the-invalidconfigurationpropertyvalueerror-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-bcf3f1f42418e9fdc3973327e42444910e69f1dc.png" alt="Inheritance diagram of pyamp.exceptions.InvalidConfigurationPropertyValueError" usemap="#inheritance6f26ee13a9" class="inheritance"/>
<map id="inheritance6f26ee13a9" name="inheritance6f26ee13a9">
<area shape="rect" href="#pyamp.exceptions.InvalidConfigurationPropertyValueError" title="pyamp.exceptions.InvalidConfigurationPropertyValueError" alt="" coords="5,7,392,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.exceptions.InvalidConfigurationPropertyValueError">
<em class="property">class </em><tt class="descclassname">pyamp.exceptions.</tt><tt class="descname">InvalidConfigurationPropertyValueError</tt><big>(</big><em>optionName</em>, <em>acceptedValues</em>, <em>section=None</em><big>)</big><a class="headerlink" href="#pyamp.exceptions.InvalidConfigurationPropertyValueError" title="Permalink to this definition">¶</a></dt>
<dd><p>The InvalidConfigurationPropertyValueError is raised in the event that
a configuration property has an invalid value.</p>
<ul class="simple">
<li>optionName &#8211; The name of the option</li>
<li>acceptedValues &#8211; The list of values accepted for this option</li>
<li>section &#8211; The section name</li>
</ul>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The exceptions module</a><ul>
<li><a class="reference internal" href="#the-finalfunctionerror-class">The FinalFunctionError class</a></li>
<li><a class="reference internal" href="#the-invalidpropertyvalueerror-class">The InvalidPropertyValueError class</a></li>
<li><a class="reference internal" href="#the-undefinedfunctionerror-class">The UndefinedFunctionError class</a></li>
<li><a class="reference internal" href="#the-undefinedpropertyerror-class">The UndefinedPropertyError class</a></li>
<li><a class="reference internal" href="#the-invalidconfigurationpropertyvalueerror-class">The InvalidConfigurationPropertyValueError class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="pyamp_processes_coroutine.html"
                        title="previous chapter">The coroutine module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="../changelog.html"
                        title="next chapter">Changelog</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_exceptions.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../changelog.html" title="Changelog"
             >next</a> |</li>
        <li class="right" >
          <a href="pyamp_processes_coroutine.html" title="The coroutine module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>